Get SMS Delivery Status

This API is used to retrieve the status of the SMS delivery to the device.

NOTE: Populating the ‘Request ID’ in the ‘Get Status Request’ API will return the API call status, whether submitted successfully or not, versus this API which provides information on the actual SMS delivery to the device.

HTTP URL
GET	/api/v3/subscriber/{type}/{value}/sms/{id}

NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’. {id} is the Request ID received when sending a text or binary SMS.

Eligibility

N/A

API Request

Request Structure

N/A

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code. See list below, under ‘Error Codes’ section.
errorMessage	String	O	Failure detailed description. See list below, under ‘Error Codes’ section.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
status	String	M	SMS delivery status. ENUM valid values: IN_PROGRESS PENDING SUCCESS FAILURE
deliveryTime	DateTime	M	Date and time when the device received the SMS (status must be ‘SUCCESS’). If the SMS was not yet delivered to the device, it will be null.

Element

Type

M/O/CM

Description

status

String

SMS delivery status. ENUM valid values:

IN_PROGRESS

PENDING

SUCCESS

FAILURE

deliveryTime

DateTime

Date and time when the device received the SMS (status must be ‘SUCCESS’). If the SMS was not yet delivered to the device, it will be null.

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
GLOBAL_1004	SMS notification ID was not found

Examples

Request Body

Copy

{
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "status": "SUCCESS",
      "deliveryTime": "2023-11-29T08:49:28.960Z"
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy

{
  "errorCode": "GLOBAL_1004",
  "errorMessage": "SMS notification ID was not found",
  "content": "",
  "pageable": null
}